Skip to main content

MenuManagerAPI Methods

An object defining methods for the MenuManagerAPI class.

SetUrl(url)​

Sets the API URL for requests.

Parameters:​

url (required): string
The new API URL.

Returns:​

Type: void
Method does not return anything

Exceptions:​

Type: ArgumentNullException
Throws ArgumentNullException if URL is null or empty.

Type: Exception
Throws Exception if the URL is invalid.

This is a sync method. Method runs synchronously.

The MenuProfileReportAsync() method generates a report based on the specified menu profile request data. This method is essential for applications that require analytics or reporting on menu usage and profile performance.

Parameters:​

request (required): MenuProfileReportRequest
The request object containing parameters needed to generate the menu profile report.

cancellationToken (optional): CancellationToken
Holds telemetry collection data. This property is advance using only.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

Returns:​

Type: Task<WrapResponse<MenuProfileReportResponse>>
An asynchronous task that returns a WrapResponse<MenuProfileReportResponse> object, encapsulating the results of the menu profile report.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetProfilesAndMenuItemParametersAsync(request, telemetryCollectorHolder)​

The GetProfilesAndMenuItemParametersAsync() method retrieves profiles and associated menu item parameters based on the provided request. This method is crucial for applications that require dynamic configuration of menu items based on user profiles.

Parameters:​

request (required): GetProfilesAndMenuItemParametersRequest
The request object containing parameters needed to fetch the profiles and menu item parameters.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

Returns:​

Type: Task<WrapResponse<GetProfilesAndMenuItemParametersResponse>>
An asynchronous task that returns a WrapResponse<GetProfilesAndMenuItemParametersResponse> object, encapsulating the profiles and their corresponding menu item parameters.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetUserMenuStructureAsync(cancellationToken, telemetryCollectorHolder)​

The GetUserMenuStructureAsync() method retrieves the customized menu structure for a user based on their role and permissions. This method is crucial for applications that need to display personalized menus to users, ensuring they only see options relevant to their access level.

Parameters:​

cancellationToken (optional): CancellationToken
Holds telemetry collection data. This property is advance using only.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

Returns:​

Type: Task<UserMenuStructureResponse>
An asynchronous task that returns a UserMenuStructureResponse object, containing the menu structure relevant to the user’s role and access permissions.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​